Get AD Groups in a Role

{ getGroupsByRole }

Returns AD security groups for a given role

Method

/API/admin/getGroupsByRole

  • API Section: /API/admin
  • API Version: 1.0
  • Method operates via POST actions only.

    • NOTE: API 1.0 methods are now deprecated. Use API 2.0 methods instead

    Input Parameters

    Name

    roleId

    Type

    string

    Description

    String

    Output Response

    Successful Result Code

    200

    Response List Type

    LdapGroupDetails[]

    Description of Response Type

    The LDAP group object contains a list of all Active Directory groups. Note that the response is returned as a list of items of this object type.

    Notes

    Only applies if the AD is the authentication provider